OSDOCS-14757 greatly reducing GCP sample install config files by bscott-rh · Pull Request #93709 · openshift/openshift-docs

bscott-rh · 2025-05-22T18:39:30Z

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/OSDOCS-14757

Link to docs preview:
Customizations
Private cluster
Shared VPC
Existing VPC
Disconnected env

QE review:

QE has approved this change.

Additional information:
I modified the installation-initializing-manual.adoc file to present important parameters for XPN and private installs.

ocpdocs-previewbot · 2025-05-22T18:48:46Z

🤖 Mon Mar 16 15:29:01 - Prow CI generated the docs preview:
https://93709--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

barbacbd · 2025-06-03T14:44:25Z

+  name: master
+  replicas: 3
+  platform:
+    gcp:


Not sure how minimal you want to go but this type may not be required, but if you do want to show the structure there are certainly other fields that could be mentioned here.

yeah, I am open to suggestions. At a minimum I'd like to put 1 parameter in each section. is there another you would recommend?

barbacbd · 2025-06-03T14:45:15Z

+      type: n2-standard-4
+metadata:
+  name: test-cluster
+networking: <4>


As a default, you may be able to drop the networking section. I am sure that this is present in the base install config.

I want to include the networking stanza because this sample is also included in the "...with network customizations" installation procedure so I want to show what that portion of the file looks like.

barbacbd · 2025-06-03T14:47:00Z

-<6> The name of the GCP project where you want to install the cluster.
-<7> Optional. One or more network tags to apply to compute machines, control plane machines, or all machines.
-<8> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
+<1> The name of the subnet in the shared VPC for compute machines to use.


The credentialsMode still applies I believe. Should be leave that or mention it somewhere else ?

I was going off of what we have the parameters table, which is "If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported. "

would you recommend we still specify credentials mode? if so, which mode should we put in the sample?

barbacbd · 2025-06-03T14:47:21Z

/cc @patrickdillon

jianli-wei · 2025-06-09T08:18:17Z

+    hostPrefix: 23
+platform: <5>
+  gcp:
+    projectID: sample-project


platform.gcp.region is also a required field.

@bscott-rh Besides, I'm trying to understand the updates, for example, in the 4.18 doc chapter "Chapter 6. Installing a cluster on GCP in a disconnected environment", the section "6.5. Creating the installation configuration file" explains how to edit "install-config.yaml" to give the additional information that is required for an installation in a restricted network. But in your changes, it seems no such info, how do you expect the end-users know generally what's required?

Hi @jianli-wei , I am resuming work on this ticket finally :) I will add the region parameter.

Regarding the updates, if the correct information is in the "Creating the installation configuration file" procedure, then it is okay for it to be removed from the sample install-config.yaml file, because the sample file is only meant to be a reference for the syntax of the file, not a complete config file. Does that make sense?

bergerhoffer · 2025-06-16T18:55:01Z

The branch/enterprise-4.20 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.19. And any PR going into main must also target the latest version branch (enterprise-4.20).

If the update in your PR does NOT apply to version 4.20 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

openshift-bot · 2025-09-15T09:00:47Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot · 2025-10-16T00:30:42Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

bergerhoffer · 2025-10-20T15:26:06Z

The branch/enterprise-4.21 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.20. And any PR going into main must also target the latest version branch (enterprise-4.21).

If the update in your PR does NOT apply to version 4.21 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

bscott-rh · 2025-10-30T16:37:17Z

/remove-lifecycle rotten

openshift-bot · 2026-01-30T01:00:49Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

jianli-wei · 2026-03-10T05:59:26Z

@bscott-rh Only one minor suggestion, it is about the "Disconnected env" section, the "e. Set the publishing strategy to Internal:" is not mandatory for installing in disconnected env, so suggest to mark it as optional or delete it. Thanks!

bscott-rh · 2026-03-10T12:53:27Z

@bscott-rh Only one minor suggestion, it is about the "Disconnected env" section, the "e. Set the publishing strategy to Internal:" is not mandatory for installing in disconnected env, so suggest to mark it as optional or delete it. Thanks!

Updated, thanks

jianli-wei · 2026-03-11T07:16:06Z

/verified by jiwei

openshift-ci-robot · 2026-03-11T07:16:24Z

@jianli-wei: This PR has been marked as verified by jiwei.

Details

In response to this:

/verified by jiwei

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

maxwelldb

Lookin' good!

… config yaml

openshift-ci · 2026-03-16T15:31:02Z

@bscott-rh: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

bscott-rh · 2026-03-16T15:56:55Z

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

openshift-cherrypick-robot · 2026-03-16T15:57:46Z

@bscott-rh: #93709 failed to apply on top of branch "enterprise-4.16":

Applying: OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml
Using index info to reconstruct a base tree...
M	installing/installing_gcp/installing-gcp-customizations.adoc
M	installing/installing_gcp/installing-gcp-private.adoc
M	installing/installing_gcp/installing-gcp-shared-vpc.adoc
M	installing/installing_gcp/installing-gcp-vpc.adoc
M	installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
M	modules/installation-initializing-manual.adoc
M	modules/installation-initializing.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/installation-initializing.adoc
CONFLICT (content): Merge conflict in modules/installation-initializing.adoc
Auto-merging modules/installation-initializing-manual.adoc
Removing modules/installation-gcp-shared-vpc-config.adoc
Auto-merging installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
Auto-merging installing/installing_gcp/installing-gcp-vpc.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-vpc.adoc
Auto-merging installing/installing_gcp/installing-gcp-shared-vpc.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-shared-vpc.adoc
Auto-merging installing/installing_gcp/installing-gcp-private.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-private.adoc
Auto-merging installing/installing_gcp/installing-gcp-customizations.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-customizations.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-03-16T15:58:31Z

@bscott-rh: #93709 failed to apply on top of branch "enterprise-4.17":

Applying: OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml
Using index info to reconstruct a base tree...
M	installing/installing_gcp/installing-gcp-customizations.adoc
M	installing/installing_gcp/installing-gcp-private.adoc
M	installing/installing_gcp/installing-gcp-shared-vpc.adoc
M	installing/installing_gcp/installing-gcp-vpc.adoc
M	installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
M	modules/installation-initializing-manual.adoc
M	modules/installation-initializing.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/installation-initializing.adoc
CONFLICT (content): Merge conflict in modules/installation-initializing.adoc
Auto-merging modules/installation-initializing-manual.adoc
Removing modules/installation-gcp-shared-vpc-config.adoc
Auto-merging installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
Auto-merging installing/installing_gcp/installing-gcp-vpc.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-vpc.adoc
Auto-merging installing/installing_gcp/installing-gcp-shared-vpc.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-shared-vpc.adoc
Auto-merging installing/installing_gcp/installing-gcp-private.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-private.adoc
Auto-merging installing/installing_gcp/installing-gcp-customizations.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-customizations.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-03-16T15:59:19Z

@bscott-rh: #93709 failed to apply on top of branch "enterprise-4.18":

Applying: OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml
Using index info to reconstruct a base tree...
M	installing/installing_gcp/installing-gcp-customizations.adoc
M	installing/installing_gcp/installing-gcp-private.adoc
M	installing/installing_gcp/installing-gcp-shared-vpc.adoc
M	installing/installing_gcp/installing-gcp-vpc.adoc
M	installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
M	modules/installation-initializing.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/installation-initializing.adoc
CONFLICT (content): Merge conflict in modules/installation-initializing.adoc
Removing modules/installation-gcp-shared-vpc-config.adoc
Auto-merging installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
Auto-merging installing/installing_gcp/installing-gcp-vpc.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-vpc.adoc
Auto-merging installing/installing_gcp/installing-gcp-shared-vpc.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-shared-vpc.adoc
Auto-merging installing/installing_gcp/installing-gcp-private.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-private.adoc
Auto-merging installing/installing_gcp/installing-gcp-customizations.adoc
CONFLICT (content): Merge conflict in installing/installing_gcp/installing-gcp-customizations.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-03-16T16:00:09Z

@bscott-rh: new pull request created: #108389

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-03-16T16:01:02Z

@bscott-rh: new pull request created: #108390

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-03-16T16:01:54Z

@bscott-rh: new pull request created: #108391

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-03-16T16:02:45Z

@bscott-rh: new pull request created: #108392

Details

In response to this:

/cherrypick enterprise-4.16
/cherrypick enterprise-4.17
/cherrypick enterprise-4.18
/cherrypick enterprise-4.19
/cherrypick enterprise-4.20
/cherrypick enterprise-4.21
/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

bscott-rh added this to the Planned for 4.19 GA milestone May 22, 2025

bscott-rh added the branch/enterprise-4.19 label May 22, 2025

openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 22, 2025

ocpdocs-vale-bot reviewed May 22, 2025

View reviewed changes

Comment thread modules/installation-gcp-config-yaml-simple.adoc

bscott-rh force-pushed the OSDOCS-14757 branch from e83f0b1 to edc59a4 Compare May 22, 2025 19:38

bscott-rh changed the title ~~OSDOCS-14757 simplified GCP install config yaml file, replaced shared vpc config yaml~~ OSDOCS-14757 greatly reducing GCP sample install config files May 22, 2025

barbacbd reviewed Jun 3, 2025

View reviewed changes

openshift-ci Bot requested a review from patrickdillon June 3, 2025 14:47

jianli-wei suggested changes Jun 9, 2025

View reviewed changes

kalexand-rh removed this from the Planned for 4.19 GA milestone Jun 13, 2025

bergerhoffer added the branch/enterprise-4.20 label Jun 16, 2025

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 16, 2025

openshift-ci Bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 15, 2025

openshift-ci Bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 16, 2025

bergerhoffer added the branch/enterprise-4.21 label Oct 20, 2025

bergerhoffer added this to the Continuous Release milestone Oct 20, 2025

bscott-rh force-pushed the OSDOCS-14757 branch from edc59a4 to b61706c Compare October 30, 2025 16:35

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 30, 2025

openshift-ci Bot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Oct 30, 2025

openshift-ci Bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 30, 2026

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 30, 2026

bscott-rh force-pushed the OSDOCS-14757 branch from 9217100 to d59f3bd Compare March 10, 2026 12:53

openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Mar 11, 2026

bscott-rh force-pushed the OSDOCS-14757 branch from d59f3bd to 4ae031a Compare March 11, 2026 12:12

bscott-rh added the merge-review-needed Signifies that the merge review team needs to review this PR label Mar 11, 2026

maxwelldb added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Mar 16, 2026

maxwelldb self-requested a review March 16, 2026 14:32

maxwelldb reviewed Mar 16, 2026

View reviewed changes

Comment thread modules/installation-initializing-manual.adoc Outdated

maxwelldb added ok-to-merge and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Mar 16, 2026

OSDOCS-14757 simplified install config yaml file, replaced shared vpc…

fbecbee

… config yaml

bscott-rh force-pushed the OSDOCS-14757 branch from 4ae031a to fbecbee Compare March 16, 2026 15:22

bscott-rh merged commit 2b05d92 into openshift:main Mar 16, 2026
2 checks passed

openshift-cherrypick-robot mentioned this pull request Mar 16, 2026

[enterprise-4.19] OSDOCS-14757 greatly reducing GCP sample install config files #108389

Merged

openshift-cherrypick-robot mentioned this pull request Mar 16, 2026

[enterprise-4.20] OSDOCS-14757 greatly reducing GCP sample install config files #108390

Merged

openshift-cherrypick-robot mentioned this pull request Mar 16, 2026

[enterprise-4.21] OSDOCS-14757 greatly reducing GCP sample install config files #108391

Merged

openshift-cherrypick-robot mentioned this pull request Mar 16, 2026

[enterprise-4.22] OSDOCS-14757 greatly reducing GCP sample install config files #108392

Merged

Conversation

bscott-rh commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

barbacbd commented Jun 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bergerhoffer commented Jun 16, 2025

Uh oh!

openshift-bot commented Sep 15, 2025

Uh oh!

openshift-bot commented Oct 16, 2025

Uh oh!

bergerhoffer commented Oct 20, 2025

Uh oh!

bscott-rh commented Oct 30, 2025

Uh oh!

openshift-bot commented Jan 30, 2026

Uh oh!

jianli-wei commented Mar 10, 2026

Uh oh!

bscott-rh commented Mar 10, 2026

Uh oh!

jianli-wei commented Mar 11, 2026

Uh oh!

openshift-ci-robot commented Mar 11, 2026

Uh oh!

maxwelldb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

openshift-ci Bot commented Mar 16, 2026

Uh oh!

Uh oh!

bscott-rh commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

bscott-rh commented May 22, 2025 •

edited

Loading

ocpdocs-previewbot commented May 22, 2025 •

edited

Loading